Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Fix compatibility issues with opentelemetry.io #953

Merged
merged 1 commit into from
Sep 24, 2021
Merged

docs: Fix compatibility issues with opentelemetry.io #953

merged 1 commit into from
Sep 24, 2021

Conversation

arielvalentin
Copy link
Contributor

The changes I submitted in #930 were optimized for a GitHub markdown, however when I integrated them into opentelemetry.io I ran into issues with navigation, duplicate headers, and some odd rendering issues.

The changes included in this PR update the Markdown to work better with Hugo and opentelemetry.io:

2021-09-22_13-35-01

2021-09-22_13-40-09

@arielvalentin arielvalentin self-assigned this Sep 22, 2021
@arielvalentin arielvalentin mentioned this pull request Sep 22, 2021
Merged
ahayworth
ahayworth approved these changes Sep 22, 2021
View reviewed changes
Copy link
Contributor

@ahayworth ahayworth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not the tiniest clue how these changes actually fix the visual problems, but I absolutely trust that they do. 😄 😄 😄 😄

@arielvalentin
Copy link
Contributor Author

@ahayworth The main problem was I reused the same description on every page with an image of a Ruby. I thought it was a "meta" description but no it was included as a header on every page.

@ahayworth
Copy link
Contributor

@ahayworth The main problem was I reused the same description on every page with an image of a Ruby. I thought it was a "meta" description but no it was included as a header on every page.

Ah that makes sense!

@arielvalentin
Copy link
Contributor Author

Oh also navigation is busted because the io site processes the MD to generate static HTML. I had to sacrifice MD navigation as a result.

fbogsany
fbogsany approved these changes Sep 24, 2021
View reviewed changes
Copy link
Contributor

@fbogsany fbogsany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fine to break MD navigation - these files are intended purely for opentelemetry.io.

@fbogsany fbogsany merged commit 8495030 into open-telemetry:main Sep 24, 2021
@chalin chalin mentioned this pull request Oct 18, 2021
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ahayworth ahayworth ahayworth approved these changes

@fbogsany fbogsany fbogsany approved these changes

@dazuma dazuma Awaiting requested review from dazuma dazuma is a code owner

@ericmustin ericmustin Awaiting requested review from ericmustin ericmustin is a code owner

@mwear mwear Awaiting requested review from mwear mwear is a code owner

@robertlaurin robertlaurin Awaiting requested review from robertlaurin robertlaurin is a code owner

Assignees

@arielvalentin arielvalentin

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@arielvalentin @ahayworth @fbogsany